home *** CD-ROM | disk | FTP | other *** search
/ Dr. Windows 3 / dr win3.zip / dr win3 / PROGRAMR / HLPDK80.ZIP / HLPDK.DOC < prev    next >
Text File  |  1993-08-01  |  43KB  |  890 lines
  1.  
  2.  ╔══════════════════════════════════════════════════════════════════════════╗
  3.  ║                                                                          ║
  4.  ║                                 ISoft D&M                                ║
  5.  ║                                 POB. 5517                                ║
  6.  ║                           Coralville IA 52241                            ║
  7.  ║                                   U.S.A                                  ║
  8.  ║                                                                          ║
  9.  ╚══════════════════════════════════════════════════════════════════════════╝ 
  10.  
  11. *******************************************************************************
  12. * HLPDK- Help Engine Dev. Kit : helpEng Doc V8.0                              *
  13. * LAST UPDATE - Aug. 01, 1993. (c) 1992,93 - Loewy Ron.                       *
  14. *******************************************************************************
  15.  
  16.  
  17.  
  18.         RL Help Engines.
  19.         
  20.         Help Compiler, Run-Time help engines and docs.
  21.  
  22.         Support for Dos, OS/2, DESQview/X & Windows.
  23.         Creates Documentation (Text) from the same source.
  24.  
  25.         Supported Formats :
  26.  
  27.         Native(PX), Native(Mem), Win30, Win31, QuickHelp, 
  28.         THELP, TVHC, POPHELP, DESQview/X, OS/2, Text, RTF (Word Processors)
  29.  
  30.         "Write Once, Help Many!"
  31.  
  32.                    
  33. *******************************************************************************
  34. *                                  File-List                                  *
  35. *******************************************************************************
  36.  
  37.  This package contains the following files :
  38.  
  39.  HELPENG.EXE    - Help Engine.
  40.  HELPC.EXE      - Help Compiler.
  41.  HE.EXE         - Mem Help Engine.
  42.  HLPDK.DOC      - This file.
  43.  HELPC.DOC      - Help Compiler documentation
  44.  HELPDEMO.HDF   - Demo Help Project.
  45.  2NDDEMO.HDF    - Demo Help Project - file 2.
  46.  HELPDEMO.HLP   - Demo Help Project file for Windows WINHELP. 
  47.  HLPDK.REG      - Registration file.
  48.  HLPDK.HDF      - Help Development Kit hypertext help database source.
  49.  HLPDK.HDT      - Help Development Kit help database file.
  50.  HLPDK.SET      - Help Development Kit help database file.
  51.  HLPDKTOP.*     - Help Development Kit help database files.
  52.  HLPDKLNK.*     - Help Development Kit help database files.
  53.  HLPDKKEY.*     - Help Development Kit help database files.
  54.  PROGRAMS.TXT   - ISoft D&M shareware products description.
  55.  
  56. *******************************************************************************
  57. *                                Why Register                                 *
  58. *******************************************************************************
  59.  
  60.   The Help Engine Development Kit (HLPDK) is a shareware product, 
  61.  if you find this product valuable, please register it. 
  62.  This section describes the reasons you should register.
  63.  
  64.   By registering you will receive a complete discussion
  65.  of the help engine features, and many examples of usage. You will receive a 
  66.  diskette with the latest HLPDK version, and DPMI (dos protected mode)
  67.  versions of the help compiler and engines!. (The memory version of the
  68.  help engine can display huge databases only in the protected mode
  69.  version).
  70.  
  71.   Your registration will help us to create the next versions of HLPDK, that
  72.  will include more options, and features, some of them might even be your
  73.  enhancement requests!.
  74.  
  75.   A point to consider - If you want to create Windows Help source files,
  76.  you will have to purchase a word processor that can output RTF files,
  77.  the WORD for Windows 2.0 package, for example, is listed at around $500!.
  78.  
  79. *******************************************************************************
  80. *                                  What's New                                 *
  81. *******************************************************************************
  82.  
  83.   Version 8.0
  84.  
  85.         - Added the /RM switch to the helpC compiler. If you set this switch
  86.           off (/RM-) the cross reference temporary tables will be created on
  87.           disk instead of in memory. The disadvantage is that the report will 
  88.           be much slower, the advantage - you will need less memory for the 
  89.           compiler. When you try to compile huge databases, and do not have 
  90.           enough memory, use this option. (By default /RM is set to on /RM+).
  91.  
  92.         - Native format databases include a new field - tType of 1 character
  93.           in the topics table. This character is needed to support different 
  94.           types of topics. Databases from previous versions will have to be
  95.           re-compiled.
  96.  
  97.         - Added support for advanced word processors with the helpC /RTF
  98.           switch. Use this switch to create a version of documentation
  99.           that can be imported, with smart formatting options, by word
  100.           processors that support the RTF format. (Such as Microsoft Word
  101.           for Windows, Word Perfect for Windows and Lotus AMI PRO). With the
  102.           introduction of this option - you can create help database to 
  103.           multiple platforms, formatted text for "readme" computerized
  104.           documentation and professional word processor documentation from
  105.           the same source!.
  106.  
  107.         - Added the .POPUP and .END-POPUP (.ENDPOP) commands to the HDF syntax.
  108.           Use these commands to define popup definition topics. Popup 
  109.           definition topics are used as glossary entries that the user can
  110.           consult to see a definition without losing the current position
  111.           in the topic he is reading. POPUP entries are supported in the 
  112.           winhelp, Native Paradox and Native Memory formats. In the other 
  113.           targets, the popup entries are used as regular topics.
  114.  
  115.         - In the Text and RTF targets the popup entries will be converted to 
  116.           a glossary file/chapter, You can add this file as an appendix to your
  117.           document file.
  118.  
  119.         - Added a conditional define (NATIVE) when helpC /PX+, /MT+ targets
  120.           are chosen.
  121.  
  122. *******************************************************************************
  123. *                                Introduction                                 *
  124. *******************************************************************************
  125.  
  126.   The Help Engine Development Kit is a system that allows you to create 
  127.  hyper-text database help systems with topics and hot links, using a simple
  128.  text editor and the help compiler. 
  129.  
  130.   The help databases can be distributed (free of charge) with the HELPENG or
  131.  HE help engine display programs. 
  132.  
  133.   The help database format is release to the public domain, if you own the 
  134.  Paradox Engine you can use the help databases with your own programs. 
  135.  
  136.   Borland Pascal Users can purchase the Help Engine Source Code even
  137.  for Applications that do not use the paradox engine, using the Native Mem
  138.  format.
  139.  
  140.   The helpC compiler that is part of this development kit includes the
  141.  ability to create Windows Help source files from the same source the 
  142.  dos help sources are created!. Write your help once, and create help
  143.  databases for Dos, Windows, OS/2 and DESQview/X !
  144.  
  145.   From the same source you created your hypertext database, you can create
  146.  a text document with automatic table of contents, glossary and index sections!
  147.  
  148.   Using the RTF target you can prepare your proffesional documentation
  149.  by generating word processors documents, all from the same source!
  150.  
  151.   Contact ISoft D&M if you want to purchase the WINTEXT UI library for 
  152.  Turbo Pascal programs, and use the help engine window in your pascal
  153.  programs.
  154.  
  155. *******************************************************************************
  156. *                                    Setup                                    *
  157. *******************************************************************************
  158.  
  159.   Copy the files in this package to a directory of your choice.
  160.  
  161. *******************************************************************************
  162. *                                 Quick Start